home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d6 / tmstx24.arc / TIMESTAX.TXT < prev   
Text File  |  1990-10-01  |  57KB  |  1,382 lines

  1.  
  2.  
  3.                                   TimeStax (TM)
  4.  
  5.                          The Personal Timecard Manager
  6.  
  7.  
  8.  
  9.  
  10.                                  User's Manual
  11.  
  12.  
  13.  
  14.                                   
  15.                                   Version 2.4
  16.  
  17.                                February 19, 1990
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                               _______
  27.                          ____|__     |               (tm)
  28.                       --|       |    |-------------------
  29.                         |   ____|__  |  Association of
  30.                         |  |       |_|  Shareware
  31.                         |__|   o   |    Professionals
  32.                       -----|   |   |---------------------
  33.                            |___|___|    MEMBER
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.                              Copyright 1988-1990
  44.                              All rights reserved.
  45.  
  46.  
  47.                              Johnson Technologies
  48.                              10564 N. Blaney Avenue
  49.                              Cupertino, CA.  95014
  50.  
  51.                              Phone: (408) 255-4213
  52.  
  53.                      T A B L E   O F   C O N T E N T S
  54.  
  55. INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . .  1
  56.  
  57. 1. INSTALLATION AND SETUP. . . . . . . . . . . . . . . . . . .  2
  58.      1.1  Installation for Local Area Network. . . . . . . . .  2
  59.      1.2  Installation for Single PC with hard disk. . . . . .  2
  60.  
  61. 2. GETTING STARTED . . . . . . . . . . . . . . . . . . . . . .  2
  62.  
  63. 3. TIMECARD VIEW SCREEN. . . . . . . . . . . . . . . . . . . .  3
  64.      3.1  View Screen - Appearance . . . . . . . . . . . . . .  3
  65.      3.2  View Screen - cursor movement keys . . . . . . . . .  4
  66.      3.3  View Screen - Commands . . . . . . . . . . . . . . .  4
  67.  
  68. 4. TIMECARD ADD SCREEN . . . . . . . . . . . . . . . . . . . .  6
  69.      4.1  Add Screen - Appearance. . . . . . . . . . . . . . .  6
  70.      4.2  Add Screen - Commands. . . . . . . . . . . . . . . .  6
  71.      4.3  Add Screen - data entry instructions . . . . . . . .  7
  72.  
  73. 5. TIMECARD CHANGE SCREEN. . . . . . . . . . . . . . . . . . .  8
  74.  
  75. 6. GENERATING REPORTS. . . . . . . . . . . . . . . . . . . . .  9
  76.      6.1  Report Options Screen - Appearance . . . . . . . . .  9
  77.      6.2  Report Options Screen - cursor movement keys . . . .  9
  78.      6.3  Report Options Screen - Commands . . . . . . . . .   10
  79.      6.4  Report Options Screen - options. . . . . . . . . .   10
  80.      6.5  Report Selection Screen. . . . . . . . . . . . . .   12
  81.      6.6  Displaying and printing your report. . . . . . . .   13
  82.  
  83. 7. REPORT SAMPLES. . . . . . . . . . . . . . . . . . . . . .   14
  84.      7.1  General Instructions . . . . . . . . . . . . . . .   14
  85.      7.2  Sample Report 1 - Grand Total only . . . . . . . .   14
  86.      7.3  Sample Report 2 - One Subtotal Field . . . . . . .   15
  87.      7.4  Sample Report 3 - 2 Subtotal fields. . . . . . . .   16
  88.      7.5  Sample Report 4 - 2 Subtotal fields plus Notes . .   16
  89.  
  90. 8. SYSTEM UTILITIES. . . . . . . . . . . . . . . . . . . . .   17
  91.      8.1  Utility Screen - Appearance. . . . . . . . . . . .   17
  92.      8.2  INFO Utility . . . . . . . . . . . . . . . . . . .   17
  93.           DUMP . . . . . . . . . . . . . . . . . . . . . . .   17
  94.           FILES. . . . . . . . . . . . . . . . . . . . . . .   17
  95.           PEOPLE . . . . . . . . . . . . . . . . . . . . . .   17
  96.      8.3  DISK Utility . . . . . . . . . . . . . . . . . . .   18
  97.           PACK . . . . . . . . . . . . . . . . . . . . . . .   18
  98.      8.4  SETUP Utility. . . . . . . . . . . . . . . . . . .   19
  99.           Naming Activity Lists. . . . . . . . . . . . . . .   19
  100.           Updating Activity Lists. . . . . . . . . . . . . .   19
  101.           Assigning Activity Sublists. . . . . . . . . . . .   19
  102.  
  103.  
  104. 9. HOW & WHEN TO PERFORM AN EXPORT or IMPORT OPERATION . . .   20
  105.      9.1  Overview of EXPORT and IMPORT. . . . . . . . . . .   20
  106.      9.2  How to EXPORT timecards. . . . . . . . . . . . . .   21
  107.      9.4  How to IMPORT timecards. . . . . . . . . . . . . .   23
  108. 10. HOW & WHEN TO PERFORM AN ARCHIVE or UNARCHIVE OPERATION.   24
  109.      10.1 Overview of ARCHIVE and UNARCHIVE. . . . . . . . .   24
  110.      10.2 How to ARCHIVE timecards . . . . . . . . . . . . .   25
  111.      10.3 How to UNARCHIVE timecards . . . . . . . . . . . .   25
  112.  
  113. 11. HOW & WHEN TO PERFORM A BACKUP or RESTORE OPERATION. . .   26
  114.      11.1 Overview of BACKUP and RESTORE . . . . . . . . . .   26
  115.      11.2 How to BACKUP your database  . . . . . . . . . . .   27
  116.      11.3 How to RESTORE your database . . . . . . . . . . .   27
  117.  
  118. APPENDIX A. LAN CONFIGURATION FOR THE LAN ADMINISTRATOR. . .   28
  119.      The TIMESTAX.INI Configuration File . . . . . . . . . .   28
  120.      The MASTER Timecard Database. . . . . . . . . . . . . .   29
  121.  
  122. APPENDIX B. TECHNICAL NOTES. . . . . . . . . . . . . . . . .   30
  123.                                                                     Page 1
  124.  
  125. INTRODUCTION
  126.  
  127. Whether you are a private consultant with 100 clients, a manager
  128. working with 3 other departments, or just a busy office worker who
  129. works on several projects at once, you're probably concerned with
  130. how efficiently you spend your work day.  If you want more than the
  131. "feeling" you should have gotten more done this month then start
  132. tracking your time now with TIMESTAX - the Personal Timecard
  133. Manager.
  134.  
  135. TIMESTAX is a simple time management program for anyone who needs
  136. to monitor his or her work habits.  With a minimum of effort (10-20
  137. minutes per week) you can capture important information about which
  138. clients and projects you worked on and what specific activities you
  139. performed.  Then in about 5 seconds you can summarize the weeks or
  140. months of work you put in and see just where the time went.
  141.   
  142. You say you work in a big company and don't need to account for
  143. every minute of your time?   But when you're overdue on that 3-
  144. month project the boss is yelling about, wouldn't it be nice to
  145. have the hard evidence that you spent exactly 34% of your time in
  146. useless status meetings with him?  Or 16% of your time on those
  147. "one-time-only reports"?  Or 11% playing telephone tag?  Or 3%
  148. actually getting some work done?
  149.  
  150.  
  151. TimeStax version 2.4 provides the following features:
  152.  
  153.           o  Unlimited "stacks" of timecards that record time 
  154.              spent in any activity, classified by Date, Client, 
  155.              Project, and Task categories for unlimited number
  156.              of employees
  157.  
  158.           o  Sublists of Projects and Tasks specific to each
  159.              Client
  160.  
  161.           o  Ability to name and maintain category lists of 
  162.              unlimited length
  163.  
  164.           o  Sort timecards on screen by any category
  165.  
  166.           o  An optional 8-line Note for each timecard
  167.  
  168.           o  Online help screens
  169.  
  170.           o  Summary reporting with up to 5 levels of subtotals 
  171.              with the ability to include/exclude any Employees,
  172.              Clients, Projects, Tasks
  173.  
  174.           o  Utilities to backup and archive the databases
  175.  
  176.           o  Utilities to export/import subsets of timecards
  177.              between user databases and a master database
  178.  
  179.           o  An automatic clock to time any given activity
  180.   
  181.           o  Single-PC or LAN (not multi-user) configuration
  182.  
  183.                                                                     Page 2
  184.  
  185. 1. INSTALLATION AND SETUP
  186.  
  187. The installation method depends on whether the system is being
  188. configured for use on a standalone PC or on a Local Area Network
  189. (LAN).  Use the installation disk which accompanies this manual.
  190.  
  191. 1.1  Installation for Local Area Network 
  192.  
  193. A designated LAN Administrator is responsible for setting up all
  194. application programs on the LAN.  Please refer to Appendix A for
  195. details.
  196.  
  197. 1.2  Installation for Single PC with hard disk
  198.  
  199. With the installation disk in drive A:, type  
  200.  
  201.      C> A:Install C:\TIMESTAX.  
  202.  
  203. The installation program will create a subdirectory called
  204. "TIMESTAX" on your PC's C: drive and copy the TIMESTAX.EXE program
  205. file to it.  A set of Demo files are copied to C:\TIMESTAX\DEMO. 
  206. Use these files for practice by typing DEMO.
  207.  
  208. 2. GETTING STARTED
  209.  
  210. The best way to get familiar with TIMESTAX is to run the program as
  211. you read along in this manual.  There is not much you can do wrong,
  212. and nothing you can't undo if you follow these instructions.
  213.  
  214. To run the program, change to your C:\TIMESTAX directory and type
  215. "TIMESTAX". You may want to set up a batch file called "TS.BAT" on
  216. your root directory which will place you in the C:\TIMESTAX
  217. directory automatically and then start the program.
  218.  
  219. If you have not set up the Activity Code Tables, TIMESTAX will
  220. prompt you to do so now.  You may change these entries at any time
  221. using the SETUP Utility described in Section 12.  For now, use the
  222. ADD function to add new Employees, Clients, Projects, and Tasks to
  223. the empty lists.  If you are running on a LAN your Administrator is
  224. reponsible for assigning the Employee ID codes for you.
  225.  
  226. If this is the first time you have ever run TIMESTAX you will next
  227. be informed that there is no timecard database. Press "Y" for "Yes"
  228. when asked if it is okay to create a new database.  
  229.                                                                     Page 3
  230.  
  231. Getting Started (cont.)
  232.  
  233. The next screen you will see is the TIMESTAX MAIN MENU.
  234. This screen shows the date, a running time clock at the top
  235. right, and the five available options:
  236.  
  237.             TIMECARDS - go to the timecard View screen
  238.  
  239.             REPORTS   - go to the Report Options screen
  240.  
  241.             UTILITIES - go to the Utilities screen
  242.  
  243.             HELP      - show a Help screen for reference
  244.  
  245.             QUIT      - exit the timecard system completely
  246.  
  247. To select an option press the first letter of its name, for example
  248. press "T" to invoke the TIMECARDS option.
  249.  
  250.  
  251. 3. TIMECARD VIEW SCREEN
  252.  
  253. Each user is given one "stack" of timecards in the database.  The
  254. View screen lets you look at one particular user's stack and move
  255. forward and backward within that stack.
  256.  
  257. Press "T" from the main menu to get to the TIMESTAX View screen.
  258.  
  259. 3.1  View Screen - Appearance
  260.  
  261. If this is the first time you have ever run TIMESTAX there will not
  262. be any timecards on file.  A message-box will indicate this on the
  263. screen.
  264.  
  265. If timecards do exist, the last 15 timecards on file will be
  266. displayed on the screen.  A reverse-video "highlight bar" will
  267. highlight the last timecard (red on a color monitor).  
  268.  
  269. There are several features of the View Screen to notice right away:
  270.  
  271.      o  The date and time are shown at the top right
  272.      o  The last 15 timecards on file are shown, 1 per line
  273.      o  The message "CARD# nnn OF nnn" shows how many
  274.         timecards are on file for the current Employee,
  275.         and also indicates which one the highlight bar is
  276.         currently on.
  277.      o  A list of COMMANDS is shown at the bottom of the
  278.         screen, and the CHANGE command is highlighted.
  279.      o  'N' at the left of a timecard means a Note is attached
  280.      o  'E' at the left of a timecard means it is 'Erased'
  281.                                                                     Page 4
  282.  
  283. 3.2  View Screen - cursor movement keys
  284.  
  285. Several keys are used to make your way around the View screen. 
  286. Experiment with them to see what effect they have:
  287.      
  288. UP/DOWN ARROW KEYS:  Scroll the highlight bar up or down
  289.                      through the stack of timecards.
  290.  
  291. PAGE-UP/DOWN KEYS:   Move one entire page up or down
  292.                      through the stack of timecards.
  293.  
  294. HOME KEY:            Move the highlight bar to the very
  295.                      first timecard on file for an employee.
  296.  
  297. END KEY:             Move the highlight bar to the very
  298.                      last timecard on file for an employee.
  299.  
  300. LEFT/RIGHT ARROW     Move the COMMAND highlight bar left
  301. KEYS:                and right at the bottom of the screen
  302.  
  303. ESC KEY:             Return to the main menu screen.
  304.  
  305. ENTER KEY:           Execute the currently highlighted COMMAND
  306.  
  307.  
  308. 3.3  View Screen - Commands
  309.  
  310. The commands at the bottom of the VIEW screen are executed by one
  311. of two methods:
  312.  
  313.        1. Use the LEFT/RIGHT arrow keys to highlight the desired
  314.           command, then press the ENTER key.
  315.    or  2. Press the bold-faced letter of the desired command.
  316.  
  317. Here is a brief description of each command:
  318.  
  319. ADD:     Pop up the New Timecard screen to add timecard(s)  
  320.  
  321. CHANGE:  Go to the EDIT data entry screen to modify the
  322.          timecard that is currently highlighted on the VIEW
  323.          screen
  324.  
  325. ERASE:   Mark (or unmark) the currently highlighted timecard for
  326.          deletion (or un-deletion).  This does not physically
  327.          remove the timecard from the database, it simply marks
  328.          it with an "*" on the screen.  You must perform a PACK
  329.          operation (see UTILITIES) to remove the timecards
  330.          marked for deletion.
  331.                                                                     Page 5
  332.  
  333. 3.3  View Screen - Commands (cont.)
  334.  
  335.  
  336. HELP:    Show a help screen for reference.
  337.  
  338. JUMP:    Jump to the first timecard with a specific user-
  339.          selected date. This is only allowed if the timecards
  340.          are currently sorted by Date (the default sequence).
  341.  
  342. NAME:    Allow the user to switch to a different employee's
  343.          stack of timecards. Press ENTER to choose the highlighted
  344.          Name on the popup list.
  345.  
  346. REPORTS: Go to the Reports system.  This is exactly the same as
  347.          selecting REPORTS from the main menu.
  348.  
  349. SORT:    Allow the user to rearrange the timecards by sorting
  350.          on a specific category (Date, Tasks, Client, Project).
  351.          The currently selected Sort category is highlighted.
  352.          The new category is selected by either typing the 
  353.          bold-faced letter, or by using the LEFT/RIGHT arrow keys
  354.          and then pressing the ENTER key.  Note that for the 3
  355.          non-Date categories, sorting is done based on an internal
  356.          CODE number, not the text shown on the screen. This means
  357.          the text may not appear in "alphabetic" order on the
  358.          screen.
  359.  
  360. TIMER:   Turn the built-in timer on or off for the currently 
  361.          highlighted timecard.  TIMESTAX will automatically keep
  362.          track of the time spent on this Activity until you turn
  363.          the timer off, even when you exit TIMESTAX.  A running
  364.          clock time is shown at the right of the active timecard.
  365.  
  366.          NOTE: Only 1 timecard at a time may have the timer on.
  367.          No Utility programs or Reports may be run until the 
  368.          timer is turned off.
  369.  
  370. UTIL:    Go to the Utilities system.  This is exactly the same as
  371.          selecting UTILITIES from the main menu.
  372.  
  373. QUIT:    Return to the main menu (same as pressing the ESC key).
  374.                                                                     Page 6
  375.  
  376. 4. TIMECARD ADD SCREEN
  377.  
  378. The same Add screen is used both for adding a new timecard and for
  379. changing the timecard currently highlighted on the View screen.  
  380.  
  381. 4.1  Add Screen - Appearance
  382.  
  383. Press "A" from the TIMESTAX View screen to invoke the ADD command. 
  384. A set of windows is displayed where the information for a single 
  385. timecard will be entered.  
  386.  
  387. Notice these features of the Add Screen:
  388.  
  389.    o  The date and time are shown at the top right
  390.  
  391.    o  The message "CARD# nnn OF nnn" is shown at the top right,
  392.       and is set to be 1 more than the last existing timecard
  393.       for the currently active Employee.
  394.  
  395.    o  The named boxes across the screen are the same as on the
  396.       View screen - for example, DATE, Client, Project, Task, and
  397.       TIME. This is where you enter the information for 1 timecard.
  398.  
  399.    o  The center of the screen shows a large window which
  400.       displays data-entry instructions.  These instructions change
  401.       as you move from one entry field to the next.
  402.  
  403.    o  A list of FUNCTION-KEY COMMANDS is shown at the bottom of
  404.       the screen.
  405.  
  406.  
  407. 4.2  Add Screen - Commands
  408.  
  409. F1-HELP:  Show a help screen for reference
  410.  
  411. F2-SAVE:  Save the timecard information just entered.  If invalid
  412. data was entered you will be prompted to correct it here. When you
  413. save the timecard, another blank timecard is presented.  The Date,
  414. Client, and Project fields are held over from the last timecard for
  415. convenience.
  416.  
  417. ESC-Cancel: Return to the VIEW Screen without saving the timecard
  418. information just entered.
  419.                                                                     Page 7
  420.  
  421. 4.3  Add Screen - data entry instructions
  422.  
  423. The Add screen lets you enter information about one timecard at a
  424. time.  You may use the LEFT/RIGHT, TAB and SHIFT-TAB keys to move
  425. the highlight bar right and left through the 5 timecard fields.
  426.  
  427. DATE:  Defaults to the date of the currently highlighted timecard
  428.        (or today's date if there are no timecards on file).  The
  429.        date-field format is "MM/DD/YY".  See the instructions in
  430.        the center window.  You may enter just the month and day
  431.        (like "8/1" or "9/13") and the system will append the
  432.        current year.  You may also type a "T" to tell the system
  433.        to use TODAY's date.
  434.  
  435. Client, 
  436. Project, 
  437. and Tasks: 
  438.        Note that the names of these fields are user-defined in the
  439.        Utilities NAME program (see UTILITIES below). The rules of
  440.        data entry are the same for all 3 fields. The center window
  441.        contains a list of the allowed selections and their code
  442.        numbers.  There are 2 ways to make a selection:
  443.  
  444.    1. Type the code number and press ENTER - the text
  445.       is automatically inserted in the field box.
  446.  
  447. or 2. Use the cursor movement keys to move the
  448.       item's highlight bar to the desired choice and
  449.       press ENTER. Valid keys are UP/DOWN arrows,
  450.       PGUP, PGDN, HOME, and END. 
  451.  
  452. TIME:  There are several formats you can use to enter the time
  453.        associated with this timecard, as shown in the center
  454.        window. Whichever format you choose, the system redisplays
  455.        the time you enter in terms of hours and minutes (e.g., 90
  456.        becomes 1:30).  The database stores all times as minutes to
  457.        simplify arithmetic operations required for reports.
  458.        
  459. NOTE:  You may optionally enter up to 8 lines of free-format text
  460.        which will be associated with this timecard.  In addition
  461.        to the standard cursor movement keys the following functions
  462.        are provided:
  463.  
  464.              ALT-C - Clear the entire Note window to blanks
  465.              ALT-D - Erase the line with the cursor 
  466.              ALT-E - Erase from the cursor to the end of the line
  467.              ALT-I - Insert a new line below the current line
  468.                                                                     Page 8
  469.  
  470. 5. TIMECARD CHANGE SCREEN
  471.  
  472. Press "C" from the TIMESTAX View screen to invoke the CHANGE
  473. command.  This screen looks just like the ADD screen. The fields have 
  474. been filled in with the timecard which was highlighted on the View 
  475. Screen, so it can now be modified.  
  476.  
  477. The operation of this screen is almost identical to the operation
  478. of the ADD screen.  The only difference is that once you press the
  479. F2 function key to save the changes you are automatically returned
  480. to the View Screen.
  481.                                                                     Page 9
  482.  
  483. 6. GENERATING REPORTS
  484.  
  485. TIMESTAX can generate a variety of summary reports to help you
  486. understand where you spend your time.  The Report Generator allows
  487. you to:
  488.  
  489.      o  report on timecards between any 2 dates
  490.      o  report on any or all Employees, Clients, Projects, and
  491.         Tasks
  492.      o  show only a Grand total, or up to 5 levels of subtotals
  493.      o  show the subtotals as a percentage of the Grand total
  494.      o  include the text of every timecard Note in the report
  495.  
  496.  
  497. 6.1  Report Options Screen - Appearance
  498.  
  499. The REPORT system may be invoked in one of 2 ways:
  500.  
  501.      1. Press "R" from the Main Menu
  502.   or 2. Press "R" from the View Screen
  503.  
  504. The report screen again shows the date and time at the top right, a large 
  505. window in the center for data entry, and several FUNCTION-KEY COMMANDS at
  506. the bottom of the screen.
  507.  
  508. In general you will indicate the Reporting Options you want,
  509. optionally use the F3 function to limit which Activities are to be
  510. reported on, then press the F2 function key to start selecting and
  511. sorting the timecards.  You are then given the option of sending
  512. the report to the Screen, the Printer, or a Disk file on your PC. 
  513.  
  514. Section 7 gives details on how to generate several sample reports.
  515.  
  516.  
  517. 6.2  Report Options Screen - cursor movement keys
  518.  
  519. Use the following keys to make your way around the Report screen:
  520.      
  521. UP/DOWN ARROW KEYS,  Move up and down the data-entry fields.
  522. TAB/SHIFT-TAB:
  523.  
  524. LEFT/RIGHT ARROW     Select an item from the "SUBTOTAL ON" list
  525. KEYS:                for which you want subtotals. 
  526.  
  527. PAGE-UP/DOWN KEYS,   Jump to the top or bottom of the screen.
  528. HOME/END KEYS:       
  529.  
  530. ENTER KEY:           Accept the data for the current field, and
  531.                      move to the next field in sequence.
  532. 6.3  Report Options Screen - Commands
  533.  
  534.  
  535. F1-HELP:     Show a Help screen for reference.
  536.  
  537. F2-PROCEED:  Using the options you typed in so far, proceed to
  538.              the Select/Sort step.  You may press the ESC key to
  539.              abort this step if you feel you made a mistake.
  540.  
  541. F3-SELECT:   Go to the Report Selection screen (discussed below).
  542.  
  543. ESC-Return:  Return to the previous menu.
  544.  
  545.                                                                     Page 10
  546.  
  547. 6.4  Report Options Screen - options
  548.  
  549. The Report Selection screen controls several options in 3 main
  550. areas of the screen.  These options will tell the system how to
  551. collect and arrange the information in your report.
  552.  
  553. FROM DATE,  You can tell the system what date-range of timecards 
  554. TO DATE:    you want to report on.  If the FROM-DATE is left
  555.             blank the system starts with the 1st timecard on
  556.             file;  if the TO-DATE is left blank the system
  557.             stops at the last timecard on file.
  558.  
  559.             The date format is the standard MM/DD/YY. The
  560.             system can fill in the year for convenience. Type
  561.             'T' for Today's date.
  562.  
  563. SUBTOTALS:  You may specify up to 5 subtotal fields (or none) in
  564.             any order.  For example, choosing "EMPLOYEE and CLIENT"
  565.             means your timecards will be subtotaled first by
  566.             EMPLOYEE, then within a given EMPLOYEE by CLIENT.
  567.  
  568.             The 5 subtotal field choices are shown in a small
  569.             window to the right of the highlighted area.  You may
  570.             select a field in one of 2 ways:
  571.  
  572.                 1. Press the bold-faced letter of the subtotal
  573.                    field you want, for example press "D" to
  574.                    select "DATE".
  575.  
  576.             or  2. Use the LEFT/RIGHT arrow keys to move the
  577.                    highlight bar to the correct field name, then
  578.                    press the ENTER key.
  579.                                                                     Page 11
  580.  
  581. Report Options (cont.)
  582.  
  583.  
  584.             Note that the system won't prevent you from entering
  585.             the same Subtotal field twice, for example "CLIENT
  586.             and CLIENT".  It doesn't make much sense, but it won't
  587.             hurt anything.
  588.  
  589. VIEW OPTIONS:  
  590.             These options control the way the timecard report is
  591.             actually displayed.  The various choices for these
  592.             options are shown to the right of each field.  For
  593.             example, the VIEWING FORMAT can be hours & minutes
  594.             (hh:mm), hours & fractions-of-hours (hh.dd), or just
  595.             minutes (mmm).  
  596.  
  597.             You may select a particular setting again in one of 2
  598.             ways:
  599.             
  600.                  1. Press the bold-faced letter of the setting you 
  601.                     want, for example press "M" for "Minutes" or
  602.                     "Y" for "Yes".    
  603.  
  604.                  2. Use the LEFT/RIGHT arrow keys to move the
  605.                     highlight bar to the correct setting, then
  606.                     press the ENTER key.
  607.  
  608.             VIEWING FORMAT:  [ HH:MM, HH.DD, or MINS ]  
  609.                  Controls the format in which all times are
  610.                  displayed in the report
  611.  
  612.             SHOW PERCENTS:   [ Yes, No ]
  613.                  Show the percent-of-total for each subtotal
  614.  
  615.             SHOW NOTES:      [ Yes, No ]
  616.                  Show each timecard Note, if any.
  617.  
  618.                                                                     Page 12
  619.  
  620. 6.5  Report Selection Screen
  621.  
  622. Press the F3 key from the Report Screen.  You will see a screen
  623. which presents you with the lists of Employees, Clients, Projects, and 
  624. Tasks currently defined in your system.  Initially, all the entries on 
  625. each list are marked as Selected.  Only one list is "active" at a time, and
  626. that is the one shown with a BLACK background.  You may select
  627. items on any of the 4 lists by using the cursor keys, the SPACEBAR,
  628. and the Function keys as follows:
  629.  
  630. UP/DOWN ARROW KEYS,  Move the highlight bar up and down within
  631. PAGE UP/DOWN,        the "active" list
  632. HOME, END KEYS:
  633.  
  634. LEFT/RIGHT ARROW     Move left and right between the lists, making 
  635. KEYS:                each list "active" in turn
  636.  
  637. SPACEBAR:            Select or Unselect the current entry. Selected
  638.                      entries are marked with a ">" symbol.
  639.  
  640. F2:                  Proceed with the report, using the lists as
  641.                      marked.  Only timecards that refer to Selected
  642.                      entries will be included in the report.
  643.  
  644. F3:                  Select ALL the entries in the active list
  645.  
  646. F4:                  Unselect ALL the entries in the active list
  647.  
  648. ESC:                 Cancel your selections, return to Report
  649.                      Screen 
  650.  
  651.                                                                     Page 13
  652.  
  653. 6.6  Displaying and printing your report
  654.  
  655.  
  656. After the system selects and sorts the timecards you requested, you
  657. will see the Output Destination screen.  Simply type the first letter of 
  658. the destination of your report: 
  659.  
  660.     S - sends the report to the screen, pausing after each
  661.         screenful of data.
  662.  
  663.     P - sends the report to the printer.
  664.  
  665.     D - sends the report to a disk file for later printing or 
  666.         enhancement with a word processor.  The system will
  667.         prompt you to type in the name of the file.
  668.  
  669. After the system processes the report you will be returned to this
  670. screen.  This allows you to review the report or change its
  671. destination, without having to re-specify the reporting options and
  672. re-sort the records.  For example you may want to see the report on
  673. the screen first before deciding to send it to the printer.
  674.  
  675. Press the ESC key to return to the Report Options screen.
  676.                                                                     Page 14
  677.  
  678. 7. REPORT SAMPLES
  679.  
  680. 7.1  General Instructions
  681.  
  682. The best way to see the effects of the various options is just to
  683. experiment.  For example, choose a date range of a week or so to
  684. limit the time it takes to select and sort.  Then select 1 or more
  685. subtotal fields in the SUBTOTALS section (if no subtotal fields are
  686. selected you will get a "Grand Total" report with no subtotals). 
  687. Limit your report to only 1 Project using the F3 key, or change
  688. some of the Viewing options.  Finally, press the F2 key to start
  689. selecting and sorting.
  690.  
  691. Remember - reports do not change what's in the database so you
  692. can't accidentally erase any timecards or do any other damage here.
  693.  
  694. You can interrupt the sort process by pressing the ESC key.
  695.  
  696. When the Output Destination screen appears, press S to send the
  697. report to the screen.
  698.  
  699. Note that the following sample reports show only the 1st page of
  700. multi-page reports.
  701.  
  702.  
  703. 7.2  Sample Report 1 - Grand Total only
  704.  
  705. For a grand total report only the From-Date and To-Date were filled in.  
  706. The user then pressed the F2 key to proceed. 
  707.  
  708. The number of records being selected and sorted is displayed near
  709. the bottom of the screen, showing how many timecards were found
  710. between the two dates. 
  711.  
  712. Notice that the report heading indicates:
  713.  
  714.     a. the date and time the report was run
  715.     b. the date range specified by the user
  716.     c. no subtotal fields were specified.
  717.  
  718. Also notice that the total time is displayed in the default format
  719. of hours and minutes.
  720.                                                                     Page 15
  721.  
  722. 7.3  Sample Report 2 - One Subtotal Field
  723.  
  724. Here we specified a single sort field in the SUBTOTALS section, namely 
  725. Client.  The report now shows that:
  726.  
  727.     a. the subtotal field is displayed in the report heading.
  728.     b. the grand total is shown first
  729.     c. the timecard times are subtotaled by Client.
  730.  
  731. Notice that the grand total is shown first, then the subtotals. 
  732. This is a little different than a standard accountant's way of
  733. showing a progression of subtotals, which usually appear as a
  734. column of numbers that add up to the grand total:
  735.  
  736.     A1
  737.        B1 25
  738.        B2  5
  739.        -----
  740.           30 Subtotal
  741.     A2
  742.        B1 30
  743.        B2 10
  744.        B3 10
  745.        -----
  746.           50 Subtotal
  747.     --------
  748.           80 Grand Total
  749.  
  750. The alternate idea here is that the user can "explode" a given
  751. total into subtotals, or "collapse" it back just by specifying more
  752. or fewer subtotal fields:
  753.  
  754. No subtotals       1 subtotal         2 subtotals
  755. Grand Total 80     Grand Total 80     Grand Total 80
  756.                      A1 30             A1 30
  757.                      A2 50               B1 25
  758.                                          B2  5
  759.                                        A2 50
  760.                                          B1 30
  761.                                          B2 10
  762.                                          B3 10
  763.  
  764. This "nesting" can occur up to 5 levels deep. At each level the
  765. total of that group is presented first, then the subtotal within
  766. that group.  One advantage of this approach is that you can see the
  767. grand total right away, without having to page-down to the end of
  768. the report.  By making use of indentation the report lets you see
  769. group subtotals more quickly even if all 5 levels are involved.
  770.                                                                     Page 16
  771.  
  772. 7.4  Sample Report 3 - 2 Subtotal fields
  773.  
  774. Here we specified a report subtotaled by Task within Client, showing 
  775. percentages. The report now shows the 2 levels of subtotals using the 
  776. indentation described above.
  777.  
  778. Notice that the percentages of the Tasks reflect the percentage of
  779. the Client it "belongs" to.  In other words, a subgroup's
  780. percentages are only in terms of the group directly above it, and
  781. do not reflect a percentage of the Grand Total. 
  782.  
  783. In turn, the Client percentages are in terms of the Grand Total
  784. because Client was the primary Subtotal field specified.
  785.  
  786.  
  787. 7.5  Sample Report 4 - 2 Subtotal fields plus Notes
  788.  
  789. Here we specified a report subtotaled by Task within Client, showing Notes.
  790. We also changed the VIEWING FORMAT to "hh.dd" (decimal time).  The 
  791. resulting report shows the time and the Note text for every timecard, 
  792. beneath the last subtotal field (Tasks).  You may want to see all cards as a 
  793. double-check of your data entry.  For example, if you see a timecard was 
  794. recorded with a time of 16 hours you might want to go back to the View 
  795. screen and correct it.
  796.                                                                     Page 17
  797.  
  798. 8. SYSTEM UTILITIES
  799.  
  800.  
  801. 8.1  Utility Screen - Appearance
  802.  
  803. The UTILITIES system may be invoked in one of 2 ways:
  804.  
  805.      1. Press "U" from the Main Menu
  806.   or 2. Press "U" from the View Screen
  807.  
  808. You will be presented with the screen which lists the following 4 
  809. Utility Options:
  810.  
  811.      1.  INFO  - Display/print summary information about all the
  812.                  TIMESTAX database files
  813.  
  814.      2.  DISK  - Perform any of the disk input/output operations, 
  815.                  (Import/Export, Archive/Unarchive, etc.)
  816.  
  817.      3.  SETUP - Update Activity Code Tables or change their Names 
  818.  
  819.      4.  QUIT  - Return to the previous screen.
  820.  
  821. To select an option press its first letter, for example press "D"
  822. to invoke the Disk Utilities.
  823.  
  824.  
  825. 8.2  INFO Utility
  826.  
  827. Press "I" from the Utilities Main Menu to invoke the INFO utility. 
  828. The options presented are:
  829.  
  830. DUMP:   Display or print every timecard in the database for
  831.         debugging purposes.  The ID# field is the Employee ID number; 
  832.         the EXP field indicates whether the timecard was exported yet; 
  833.         the S field indicates status, where a "*" means the timecard has
  834.         been marked for deletion.
  835.  
  836. FILES:  Display summary information about all the disk files      
  837.         relevant to the TIMESTAX System.  
  838.  
  839. PEOPLE: Display summary information about all the timecards in the
  840.         database, grouped by Person.
  841.  
  842. QUIT:   Return to the Utility menu screen.
  843.  
  844.                                                                     Page 18
  845.  
  846. 8.3  DISK Utility
  847.  
  848. Press "D" from the Utilities Main Menu to invoke the DISK utility. 
  849. The options presented are:
  850.  
  851. PACK:  This operation will perform a database "pack", which will
  852.        physically delete all timecards previously marked for
  853.        deletion (by using the ERASE command from the View
  854.        screen).  This operation may take several minutes, so be
  855.        prepared to wait.  The screen will show what record number
  856.        is currently being processed.  
  857.  
  858. THE FOLLOWING OPTIONS ARE EXPLAINED MORE FULLY IN A SEPARATE
  859. SECTION BECAUSE THEY MUST BE DONE CAREFULLY!
  860.  
  861. BACKUP/RESTORE:  
  862.        These operations will copy all relevant timecard files to
  863.        or from the disk drive you specify.
  864.  
  865. EXPORT/IMPORT:  
  866.        These operations are used to COPY a subset of your
  867.        timecards (within a date range you specify) in one
  868.        of 2 directions:
  869.  
  870.           EXPORT: FROM your timecard database TO another disk
  871.                   file
  872.  
  873.           IMPORT: FROM another disk file INTO your timecard
  874.                   database
  875.  
  876. You would typically do an EXPORT in order to create a copy of a
  877. week or month's worth of your timecards on another disk, which is
  878. then given to the System Administrator to incorporate into a Master
  879. Timecard Database.
  880.  
  881. ARCHIVE/UNARCHIVE:  
  882.        These operations are used to PERMANENTLY MOVE a subset of
  883.        your timecards (within a date range you specify) in one
  884.        of 2 directions:
  885.  
  886.           ARCHIVE:  FROM your timecard database TO another disk
  887.                     file
  888.  
  889.         UNARCHIVE:  FROM another disk file INTO your timecard
  890.                     database
  891.  
  892. You would typically do an ARCHIVE in order to erase old or unwanted
  893. timecards which are taking up space in your database, yet save them
  894. onto a diskette for future reference.
  895.  
  896. QUIT:   Return to the Utility menu screen.
  897.                                                                     Page 19
  898.  
  899. 8.4  SETUP Utility
  900.  
  901. Press "S" from the Utilities Main Menu to invoke the SETUP utility. 
  902. The information you fill in here is kept in the TIMESTAX.TBL 
  903. configuration file.  The options you are presented with are described below:
  904.  
  905. Naming Activity Lists
  906.  
  907. Press "N" from the SETUP menu.  You may name the Activity Categories 
  908. anything you like by typing in the names in the fields provided.  
  909. Press the F2 key to return to the SETUP menu.
  910.  
  911.  
  912. Updating Activity Lists
  913.  
  914. Press "1", "2", or "3", or "P" from the SETUP menu.  Each of these
  915. options presents you with a popup list.  You may Add an item, Change the 
  916. spelling of an item, or mark an item as "* deleted *".  When adding People, 
  917. you are prompted to enter an ID number from 1-99.  When adding other Activity
  918. items the system automatically assigns the next highest internal Code number.
  919.  
  920. WARNING:  The timecard database (TIMESTAX.DAT) stores only the Code
  921. Numbers of the various Activities, not the actual text.  The text
  922. is stored only in the TIMESTAX.TBL configuration file.  This has a
  923. few important implications:
  924.  
  925.       1)  It is imperative that LAN users work from the same lists
  926.           of Activities to be able to exchange export/import files.
  927.  
  928.       2)  To prevent mixups you are not allowed to delete an
  929.           Activity entry while there are still timecards which
  930.           refer to it.
  931.  
  932.       3)  You may not re-assign the internal Code Numbers or
  933.           renumber them.
  934.  
  935. Assigning Activity Sublists
  936.  
  937. Press "A" from the SETUP menu.  Here you may assign
  938. to Activity list 1 specific subsets of items in Activity lists 2
  939. and 3.  For example, if you have defined Clients, Projects, and
  940. Tasks then you can assign certain Projects and Tasks to each
  941. individual Client.  This can greatly simplify the job of entering
  942. timecards in the Add screen, because you are shown only those
  943. Projects and Tasks which that Client is assigned.
  944.  
  945. The method of moving around this screen and making your assignments
  946. is the same method used on the Report Selection screen (see Section
  947. 6.5).
  948.                                                                     Page 20 
  949.  
  950. 9. HOW & WHEN TO PERFORM AN EXPORT or IMPORT OPERATION
  951.  
  952.  
  953. 9.1  Overview of EXPORT and IMPORT
  954.  
  955. If you are using TIMESTAX in a LAN environment you may need to
  956. periodically give subsets of your timecards to the System
  957. Administrator, who then loads them into a centrally maintained
  958. Master Database of everyone's timecards. Or you may want to export
  959. some timecards to an ASCII file for use in an accounting or
  960. database package.
  961.  
  962. Please note that the current version of TIMESTAX system is not a
  963. true "multi-user" system, where everyone enters data into a central
  964. Master Database directly.  Instead, everyone maintains his/her own
  965. database of timecards, and a master database is periodically
  966. updated with the latest timecards from each person.
  967.  
  968. For example, if there are 5 people using the system there will
  969. really be 6 databases - the 5 personal databases kept by each
  970. individual (which contains only his/her timecards), and a 6th
  971. database kept by the Administrator (which contains everyone's
  972. timecards).  The Export/Import operations are intended to
  973. facilitate this transfer from your personal database to the Master
  974. database.   By definition:
  975.     
  976.     a. EXPORT is a transfer from your database to some small 
  977.               file on another diskette (or in a "common" area
  978.               on the LAN).  YOU perform exports.
  979.  
  980.     b. IMPORT is a transfer from that small file into the master
  981.               database.  The SYSTEM ADMINISTRATOR performs 
  982.               imports.
  983.  
  984. You and your Administrator should agree on how often you will
  985. export timecards - every week, every 2 weeks, every month.  Try to
  986. keep on schedule with your exports to ensure that the master
  987. database has the latest information.  That way the Administrator
  988. can generate summary management reports which cover the entire
  989. group's work.
  990.  
  991.                                                                     Page 21
  992.  
  993. 9.2  How to EXPORT timecards
  994.  
  995. Bring up the Utilities Menu by pressing "U" from either the
  996. TIMESTAX Main Menu screen or the TIMESTAX View screen.  From there
  997. press "D" to invoke the Disk Utility menu.  Now press "E" to
  998. perform an export operation.  
  999.  
  1000. You are now asked to specify the date-range of timecards you want
  1001. to export.  If your group has agreed to do exports each week, you
  1002. may be trying this on Monday  morning.  In that case the From and
  1003. To-Dates would indicate the previous Monday through the previous
  1004. Sunday.
  1005.  
  1006. Next you are asked what disk file to write the export file to.  The
  1007. system shows you the default filename (which it gets from the
  1008. TIMESTAX.INI file).  If the default is acceptable you can just
  1009. press the ENTER key to proceed.  You can however change the
  1010. filename here before pressing ENTER.  For example, if the
  1011. TIMESTAX.INI file supplies only the pathname you must fill in the
  1012. filename yourself, as in:
  1013.  
  1014.     TIMESTAX.INI says   A:\      
  1015.     You fill it out as  A:\BHP0715.DAT
  1016.  
  1017. One strategy for naming your export files might be to use your
  1018. initials plus the to-date.  For example,  file "BHP0715.DAT" would
  1019. contain Bob Programmer's timecards for the week ending 07/15.  The
  1020. next week's export file would be called "BHP0722.DAT", etc.
  1021.  
  1022. Next the system indicates how many timecards it found between the
  1023. given dates and asks you if it's okay to proceed with the export
  1024. operation.  Press the ESC key if you decide it's not okay.  If
  1025. there were NO timecards found between the given dates the system
  1026. will tell you.
  1027.  
  1028. The system now copies the selected timecards to disk and the
  1029. operation is done.  
  1030.                                                                     Page 22
  1031.  
  1032. 9.3  Cautions about EXPORTING timecards
  1033.  
  1034.  
  1035.     1. The EXPORT operation does not delete timecards from your
  1036.        database, it only makes a copy of them.  This means you
  1037.        can still generate reports using those timecards even
  1038.        AFTER you have exported them to the master database.
  1039.        For example, you might export weekly 4 times in a month
  1040.        but you want to run your own end-of-month report.  The
  1041.        timecards for the whole month will still be around on
  1042.        your personal system.
  1043.  
  1044.     2. If you try to export some or all of the same timecards
  1045.        a 2nd time you will get a warning message.
  1046.        The system has marked those timecards the
  1047.        first time they were exported and warns you about it
  1048.        now.  The danger is that later the Administrator would
  1049.        again merge your timecards into the master database and 
  1050.        end up with duplicates.  You can choose to go ahead
  1051.        with the export (for example if the Administrator has
  1052.        told you the first export was lost before it was
  1053.        processed), just be sure you are aware of the potential
  1054.        problem.
  1055.  
  1056.     3. You may get a warning that the export file you are 
  1057.        writing to already exists.  This may mean that the
  1058.        Administrator has not yet had a chance to merge it
  1059.        into the master database (or, if you are re-using
  1060.        the same floppy disk 2 weeks in a row, that the old
  1061.        export file is still on it).  You can choose to replace
  1062.        the old file here.
  1063.  
  1064.                                                                     Page 23
  1065.  
  1066. 9.4  How to IMPORT timecards
  1067.  
  1068. Only the System Administrator will normally be concerned with an
  1069. Import operation.
  1070.  
  1071. Press "I" from the DISK UTILITY menu.  You will see a screen
  1072. which asks you for the name of the file you want
  1073. to import.  The default filename is taken from the TIMESTAX.INI
  1074. file, but you may override it before you press ENTER.
  1075.  
  1076. You cannot specify a date-range for an Import operation - the
  1077. entire import file will be merged into the master database.
  1078.  
  1079. Next you will be prompted to press the ESC to exit or any other key
  1080. to proceed.  
  1081.  
  1082. Again, the system marks the import file's records so that you don't
  1083. accidentally import them a 2nd time.  If you try to do so you will
  1084. see a warning message.  You may ignore this warning f you want, but be 
  1085. aware of the consequences.
  1086.  
  1087.                                                                     Page 24
  1088.  
  1089. 10. HOW & WHEN TO PERFORM AN ARCHIVE or UNARCHIVE OPERATION
  1090.  
  1091.  
  1092. 10.1 Overview of ARCHIVE and UNARCHIVE
  1093.  
  1094. The Archive/Unarchive operations are very similar to the
  1095. Export/Import operations, with one important difference:
  1096.  
  1097.    WHEN YOU PERFORM AN ARCHIVE, THE TIMECARDS YOU SELECT
  1098.    ARE PHYSICALLY ERASED FROM THE DATABASE.
  1099.  
  1100. The whole point of archiving timecards is to do just that - get
  1101. them off your database, where they are cluttering up the file and
  1102. slowing down data entry and reporting.  
  1103.  
  1104. By definition:
  1105.     
  1106.     a. ARCHIVE   is a transfer from your database to an archive
  1107.                  file.
  1108.  
  1109.     b. UNARCHIVE is a transfer from an archive file to your
  1110.                  database.
  1111.  
  1112.  
  1113. IMPORTANT NOTE:  
  1114.  
  1115. The archive file is a cumulative file - new archive records are
  1116. added to the end of it each time you perform an Archive operation. 
  1117.  
  1118. One strategy might be to archive any timecards over 2 months old,
  1119. and to do this at the beginning of each month.  That way you would
  1120. always have at least 2 months of old timecards available "online"
  1121. for running reports, but not so many that they slow down your
  1122. system.  For example, on October 1st you could archive all the July
  1123. timecards to a file called "TIME_89.ARK"; then on November 1st you
  1124. could archive all the  August timecards into that same file.
  1125. By the end of the year all your timecards for 1989 will be
  1126. collected in the single archive file.
  1127.  
  1128. You do not HAVE to archive at all.  The system will still work but
  1129. will generally slow down as more and more timecards are
  1130. accumulated.
  1131.  
  1132. The Unarchive facility allows you to retrieve archived timecards
  1133. and merge them back into your timecard database.  You might want to
  1134. do this if you want to generate a summary report that spans many
  1135. months of timecards.
  1136.  
  1137. Note that both individual timekeepers and the Administrator will
  1138. probably want to periodically remove timecards to an archive file
  1139. to keep the system performing well.
  1140.                                                                     Page 25
  1141.  
  1142. 10.2 How to ARCHIVE timecards
  1143.  
  1144. Bring up the Utilities Menu by pressing "U" from either the
  1145. TIMESTAX Main Menu screen or the TIMESTAX View screen.  From there
  1146. press "D" to invoke the Disk Utility menu.  Now press "A" to
  1147. perform an archive operation.  
  1148.  
  1149. You are now asked to specify the date-range of timecards you want
  1150. to archive. Type in the From-date and To-date.
  1151.  
  1152. Next you are asked what disk file to write the archive file to. 
  1153. The system shows you the default filename (which it gets from the
  1154. TIMESTAX.INI file).  Normally the default is acceptable and you
  1155. just press the ENTER key to proceed.  You can however change the
  1156. filename here before pressing ENTER. As mentioned above, one
  1157. strategy for naming your archive files might be to use your
  1158. initials and the year, as in "BHP_88.ARK".
  1159.  
  1160. Next the system indicates how many timecards it found between the
  1161. given dates and asks you if it's okay to proceed with the archive
  1162. operation.  Press the ESC key if you decide it's not okay.  If
  1163. there were NO timecards found between the given dates the system
  1164. will tell you.
  1165.  
  1166. If you have not yet exported some or all of the selected timecards
  1167. you're trying to archive, you will see a warning message.
  1168. You should first export those timecards to the Administrator
  1169. before attempting to archive them.
  1170.  
  1171. The system now copies the selected timecards to the archive file
  1172. and automatically performs a "database pack" to physically remove
  1173. them from your database.
  1174.  
  1175.  
  1176. 10.3 How to UNARCHIVE timecards
  1177.  
  1178. Press "U" from the Disk Utility menu to perform an Unarchive
  1179. operation. Enter the From and To-dates to tell the system which timecards in
  1180. the Archive file you want to extract.  Then enter the name of the
  1181. Archive file you want to process.
  1182.  
  1183. Next you will be prompted to press ESC to exit or any other key to
  1184. proceed.  
  1185. IMPORTANT NOTE:
  1186. The system DOES NOT mark the archive file's records during an
  1187. Unarchive operation.  This means that you CAN accidentally
  1188. unarchive them a 2nd time and the timecard system will not warn you
  1189. about it.  If you do so you will be adding those records a 2nd time
  1190. to your database.
  1191.                                                                     Page 26
  1192.  
  1193. 11. HOW & WHEN TO PERFORM A BACKUP or RESTORE OPERATION
  1194.  
  1195.  
  1196. 11.1 Overview of BACKUP and RESTORE
  1197.  
  1198. Computer disk technology is not perfect and it is possible for data
  1199. to be lost, written over, or otherwise corrupted.  For this reason
  1200. you should FREQUENTLY back up all files on your hard disk.  There
  1201. are many commercial programs available for disk backup but the
  1202. TIMESTAX system additionally provides a way to back up just those
  1203. files it deals with.
  1204.  
  1205. The safest way to peform a backup is to copy the files to a floppy
  1206. disk which you then put in a safe place, perhaps as often as once
  1207. a week.  At the end of a month, when you have 4 or 5 backup disks,
  1208. you can re-use the 1st (oldest) disk as you start a new month.  In
  1209. this way you're never more than a week out of synch with your
  1210. backups.  In other words, if your hard disk is erased you only have
  1211. to re-enter 1 week's worth of timecards after you Restore from your
  1212. most recent backup.
  1213.  
  1214. Backups are insurance policies.  It's up to you how much risk your
  1215. willing to take and how safe you think your data is on your hard
  1216. disk.
  1217.  
  1218. Note that the Administrator must be much more concerned with doing
  1219. frequent backups because the master database is the accumulation of
  1220. everyone's timecards.  In fact, individuals may be more lax about
  1221. backing up their own systems because they think the master database
  1222. has all their timecards anyway. DO IT ANYWAY!
  1223.  
  1224. A Restore operation is done when you want to completely replace all
  1225. existing timecard files with a backup copy.  Note that a Restore
  1226. does not perform any checks of the data - it simply erases the
  1227. current files and copies the backup files in their place.
  1228.                                                                     Page 27
  1229.  
  1230. 11.2 How to BACKUP your database 
  1231.  
  1232. Bring up the Utilities Menu by pressing "U" from either the
  1233. TIMESTAX Main Menu screen or the TIMESTAX View screen.  From there
  1234. press "D" to invoke the Disk Utility menu.  Now press "B" to
  1235. perform a backup operation.
  1236.  
  1237. You are asked what drive and path to back up files to.  The default
  1238. is taken from the TIMESTAX.INI file (typically A:\), but you may
  1239. override that here.
  1240.  
  1241. Next you will be asked to press the ESC key to abandon the backup
  1242. operation, or any other key to proceed.  The system will backup all
  1243. related TIMESTAX files to the drive you have specified.
  1244.  
  1245.  
  1246. 11.3 How to RESTORE your database 
  1247.  
  1248. Press "R" from the Disk Utility menu to perform a Restore operation.  You 
  1249. will see a screen which asks you for the name of the disk drive where the 
  1250. backup files are to be found. The default filename is taken from the 
  1251. TIMESTAX.INI file, but you may override it before you press ENTER.
  1252.  
  1253. Next you will be prompted to press ESC to exit or any other key to
  1254. proceed.  The system will erase the current set of TIMESTAX files
  1255. and replace them with the ones found on the backup drive.
  1256.                                                                     Page 28
  1257.  
  1258. APPENDIX A. LAN CONFIGURATION FOR THE LAN ADMINISTRATOR
  1259.  
  1260. TIMESTAX version 2.4 is NOT a true multi-user database system.  It
  1261. will not support several users at once reading and writing to the
  1262. Master TIMESTAX.DAT file or its index files.  However it is
  1263. possible to make use of several key features of a LAN which make
  1264. controlling and maintaining the system easier.  
  1265.  
  1266. The basic concept for LAN use is that each user maintains his
  1267. personal timecards on his own local PC, while a Master Timecard
  1268. Database is maintained in a secure location on the file server. 
  1269. Periodically each user will export a subset of his timecards to a
  1270. directory on the LAN;  and a designated Administrator will import
  1271. those files into the Master database.  Strictly speaking, the
  1272. individual user files could also be on the file server in that
  1273. user's private directory.
  1274.  
  1275. The TIMESTAX.INI Configuration File 
  1276.  
  1277. TIMESTAX.INI is an ASCII text file which tells TIMESTAX where to
  1278. look for the various files it needs.  If there is no such file
  1279. TIMESTAX assumes all files are on the current working directory. 
  1280. You may also specify the name and path of TIMESTAX.INI as the 1st
  1281. argument to TIMESTAX (as in "TIMESTAX c:\LOCAL\TS.INI").  For use
  1282. in a LAN environment you might set up TIMESTAX.INI to look like
  1283. this:
  1284.  
  1285.     Text Line                 Comment                            
  1286.     SYSTEM = F:\APPS          System files are to be found in the
  1287.                               \APPS directory of the F: drive on
  1288.                               the LAN file server.
  1289.     DATA   = C:\TIMESTAX      Personal timecards are to be found
  1290.                               in the \TIMESTAX directory on the
  1291.                               C: drive of the local PC.
  1292.     BACKUP = A:               Backup files to drive A:
  1293.     EXPORT = F:\TS            Export files to path F:\TS on the
  1294.                               LAN file server
  1295.     ARCHIVE= C:\TIMESTAX\ARK  Archive to file C:\TIMESTAX\ARK
  1296.  
  1297. Some of the files TIMESTAX requires are called System files.  These
  1298. are files that should be maintained only by the Administrator in a
  1299. secure area of the LAN file server. These files are:
  1300.                
  1301.           SYSTEM FILE NAME    Description                      
  1302.           TIMESTAX.EXE        TIMESTAX executable program
  1303.           TIMESTAX.TBL        Activity Code tables
  1304.                                                                     Page 29
  1305.  
  1306. LAN CONFIGURATION (continued):
  1307.  
  1308. Once TIMESTAX is run the following Data files will be automatically
  1309. created and maintained in the directory specified by the
  1310. TIMESTAX.INI DATA parameter:
  1311.  
  1312.           DATA FILE NAME       Description                     
  1313.           TIMESTAX.DAT         Main database of timecards
  1314.           TIMESTAX.NTS         Timecard user notes
  1315.           TS_DATE.NDX          Index of timecard dates
  1316.           TS_CUST.NDX          Index of timecard Clients   
  1317.           TS_PROJ.NDX          Index of timecard Projects   
  1318.           TS_TASK.NDX          Index of timecard Tasks        
  1319.  
  1320. The MASTER Timecard Database
  1321.  
  1322. The Master Database is the same as the normal TIMESTAX database,
  1323. except that it contains all timecards from all users.  The Master
  1324. is updated periodically by the System Administrator by importing
  1325. users' export files.  It must be protected from unauthorized use. 
  1326. The simplest way to do this is to create a special Master directory
  1327. and grant access only to the Administrator:
  1328.  
  1329.    Directory  \MASTER  - contains master TIMESTAX.DAT,
  1330.                          TIMESTAX.NTS, plus master *.NDX files
  1331.  
  1332. Then the Administrator should have his/her own TIMESTAX.INI file as
  1333. set up to allow direct access to the Master Database as follows:
  1334.  
  1335.               SYSTEM = F:\APPS
  1336.               DATA   = F:\MASTER
  1337.  
  1338. Finally, create a "staging area" where all Export and Import
  1339. operations can occur.  For example, you may set up everyone's
  1340. TIMESTAX.INI file to specify:
  1341.  
  1342.               EXPORT = F:\TS_STAGE\
  1343.  
  1344. This pathname will be presented to all users when they do either an
  1345. import or an export operation. In this way users can place multiple
  1346. export files in this one directory, where they stay until the
  1347. Administrator imports them.
  1348.                                                                     Page 30
  1349.  
  1350. APPENDIX B. TECHNICAL NOTES
  1351.  
  1352. The TIMESTAX program is written in Microsoft C v5.1 (large code-
  1353. model) and uses the LATTICE (c) dBc-III database library which
  1354. allows for directly reading and writing dBase-III files.  In this
  1355. way the system has the speed and performance of a compiled language
  1356. program, and the flexibility of allowing users to design custom
  1357. reports within the standard dBase-III environment.
  1358.  
  1359. As it turns out, only the .DAT and .NTS files are dBase-III
  1360. standard (corresponding to .DBF and .DBT files).  The index files
  1361. were purposely not written in standard format to reduce the size of
  1362. the files.  Specifically, the key fields are not standard ASCII
  1363. derived from the .DBF fields, instead they are concatenations of
  1364. binary internal fields of various lengths. This should not be a
  1365. problem for the dBase user however, since he can create his own
  1366. indexes very quickly using built-in dBase commands. 
  1367.  
  1368. The dBc-III package used is not the multi-user LAN version,
  1369. although such a version is commercially available.  It was thought
  1370. that given the very large volume of timecards/records involved in
  1371. daily time-keeping, a single central multi-user file would quickly
  1372. grow too large and cumbersome to use effectively.
  1373.  
  1374. Instead, the approach we took was to provide each user with his or
  1375. her own personal timecard database with "private" timecards on it. 
  1376. The disadvantage is that each user must periodically export subsets
  1377. of the database to an Administrator, who must import those files
  1378. into the Master database.  The larger Master database exists only
  1379. for reporting purposes and not for the day-to-day access by busy
  1380. office workers.  The advantage is that each user will have a fast
  1381. and efficient system to record his time.
  1382.